Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify that /context always returns 'event' even if limit is zero #1239

Merged
merged 3 commits into from
Nov 22, 2022

Conversation

sumnerevans
Copy link
Contributor

@sumnerevans sumnerevans commented Sep 16, 2022

Signed-off-by: Sumner Evans me@sumnerevans.com


name: Clarify that /context always returns 'event' even if limit is zero
about: The spec is not clear that the limit does not apply to the event itself.
title: ''
labels: ''
assignees: ''


Pull Request Checklist

Preview: https://pr1239--matrix-spec-previews.netlify.app

Signed-off-by: Sumner Evans <me@sumnerevans.com>
Signed-off-by: Sumner Evans <me@sumnerevans.com>
@sumnerevans sumnerevans marked this pull request as ready for review September 16, 2022 04:44
@sumnerevans sumnerevans requested a review from a team as a code owner September 16, 2022 04:44
Copy link
Member

@turt2live turt2live left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

generally seems sane to me - thanks!

changelogs/client_server/newsfragments/1239.clarification Outdated Show resolved Hide resolved
data/api/client-server/event_context.yaml Outdated Show resolved Hide resolved
@@ -57,7 +57,10 @@ paths:
type: integer
name: limit
description: |-
The maximum number of events to return. Default: 10.
The maximum number of context events to return. The limit applies
to the sum of the `events_before` and `events_after` arrays. The
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there something to prove that this is true? It's generally sensible, though we do need evidence that this PR is a bug fix rather than a change.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Co-authored-by: Travis Ralston <travpc@gmail.com>
@richvdh richvdh merged commit 84fbb61 into matrix-org:main Nov 22, 2022
clokep pushed a commit to clokep/matrix-spec that referenced this pull request May 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants